Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README and CHANGELOG #130

Merged
merged 17 commits into from
Jul 14, 2021
Merged

Add README and CHANGELOG #130

merged 17 commits into from
Jul 14, 2021

Conversation

sgrossberndt
Copy link
Contributor

No description provided.

ue71603 and others added 2 commits November 30, 2020 11:26
@sgrossberndt sgrossberndt changed the title Markdowns Add README and CHANGELOG Dec 1, 2020
@sgrossberndt
Copy link
Contributor Author

I'm still not very happy with the README, which seems to have been copied from http://www.transmodel-cen.eu/standards/ojp/, uses overly complicated terms and descriptions and still doesn't convey the essentials.

@sgrossberndt sgrossberndt added the enhancement New feature or request label Dec 1, 2020
@sgrossberndt sgrossberndt added this to the v1.1 milestone Dec 1, 2020
@sgrossberndt sgrossberndt marked this pull request as draft December 1, 2020 18:57
@pvgrumbkow
Copy link
Contributor

Concerning the change log: Is the expectation, that each merge to v1.1 is manually listed there?

@ue71603
Copy link
Contributor

ue71603 commented Dec 2, 2020

I suggest we wait until all other pull requests are done, then we do a final version. Also I can update the readme.md. It is a copy of the url you mentioned, but I thought, that was an introduction as well. I will prepare a new version.

@sgrossberndt
Copy link
Contributor Author

Concerning the change log: Is the expectation, that each merge to v1.1 is manually listed there?

At least for all notable changes (those that change something for users), also see https://keepachangelog.com/en/1.1.0/
It is not a simple commit list. E.g. just updating the annotation of a single element does not qualify either in my opinion.

This shows a different more user focused content.

But I think perhas we should discuss this tomorrow.
@ue71603
Copy link
Contributor

ue71603 commented Dec 2, 2020

Updated the README a bit, I guess we will have to update it again.
About the change list. If anything needs to be done, we can do it.

sgrossberndt referenced this pull request Dec 3, 2020
Added some private modes to IndividualModesEnumeration, e.g. scooter, ride-pool-car, car-sharing, cycle-sharing, scooter-sharing.
A proper solution in OJP v2.0 would be to use something like SIRI:PrivateModeChoiceGroup, but this has currently restrictions, too. An issue will be places at SIRI for extending the PrivateModeChoiceGroup.
ue71603 and others added 3 commits December 7, 2020 12:54
A readme and a release note is added as markdown.
This shows a different more user focused content.
@sgrossberndt
Copy link
Contributor Author

Please review and update this patch, best before the next meeting:

As visible in https://github.com/jmaerki/OJP/tree/doc-issues once #154 has been merged the file /docs/README.md will be displayed at / if there is no /README.md.

Therefore I propose to bring this patch up to date and merge it first.

@sgrossberndt sgrossberndt marked this pull request as ready for review June 21, 2021 14:11
CHANGELOG.md Outdated Show resolved Hide resolved
@sgrossberndt sgrossberndt requested a review from skinkie July 13, 2021 11:10
@sgrossberndt sgrossberndt merged commit 47a2aec into changes_for_v1.1 Jul 14, 2021
@sgrossberndt sgrossberndt deleted the markdowns branch July 14, 2021 10:27
@trurlurl trurlurl mentioned this pull request Jan 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants